API

System APIs

PUT system/domain-values/{domainValueId}/local-filters

Stores a list of local filters for a specific domain value

HTTP method PUT
URI https://api.rambase.net/system/domain-values/{domainValueId}/local-filters
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {domainValueId} Identifier of the domain value
Integer, minimum 10000
Successful HTTP status code 200
API resource identifier 353, version 7

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<LocalFilters
LocalFilters

This field is optional.

>
2
     <Filter
Filter

This field is optional.

>
3
          <Scope
Scope

Scope of the filter line (GLOBAL/LOCAL)

This field is optional.

>{String}</Scope>
4
          <Alternative
Alternative

Alternative

This field is optional.

>{String}</Alternative>
5
          <Source
Source

Source

This field is optional.

>{String}</Source>
6
          <Operator
Operator

Relation/Operator

This field is optional.

>{String}</Operator>
7
          <Value
Value

Value to compare againts

This field is optional.

>{String}</Value>
8
          <Field
Field

Field from Source to compare

This field is optional.

>{String}</Field>
9
     </Filter>
10
</LocalFilters>
1
{
2
     "localFilters
LocalFilters

This field is optional.

": [
3
          {
4
               "scope
Scope

Scope of the filter line (GLOBAL/LOCAL)

This field is optional.

": "{String}",
5
               "alternative
Alternative

Alternative

This field is optional.

": "{String}",
6
               "source
Source

Source

This field is optional.

": "{String}",
7
               "operator
Operator

Relation/Operator

This field is optional.

": "{String}",
8
               "value
Value

Value to compare againts

This field is optional.

": "{String}",
9
               "field
Field

Field from Source to compare

This field is optional.

": "{String}"
10
          }
11
     ]
12
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101015 HTTP 404 Permission not found
Error 101420 HTTP 404 Setting definition not found
Error 100138 HTTP 400 Only the operators NE and EQ can be used on Values containing a comma list or wildcards ( ?, * )